---
target: Umo Editor Next
keywords: Umo Editor Next,Umo Editor 官网,富文本编辑器,文档编辑器,文档编辑,协同办公
description: Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。
---

# 方法列表

除 Umo Editor [方法列表](../editor/methods)中提供的方法外，Umo Editor Next 还提供了以下方法：

## 方法说明

使用方法同 Umo Editor [方法列表](../editor/methods)。

### getThumbnail

**说明**：获取当前文档的缩略图。

**参数**：

- `scale`，Number，缩略图缩放比例，默认值为 `0.5` 。

**返回值**：当前文档的缩略图 `Blob` 格式数据或者直接抛出错误。

### insertMarkdown

**说明**：插入 Markdown 格式文本。

**参数**：

- `markdown`，String，Markdown 文本。
- `options`，MarkdownIt 的配置项，见：https://markdown-it.github.io/markdown-it/#MarkdownIt.new 。

**返回值**：无

### getJSONByMarkdown

**说明**：把 Markdown 文本转成 Umo Editor 可识别的 JSON 格式数据。

**参数**：

- `markdown`，String，Markdown 文本。
- `exRules`，Object，Markdown 扩展规则。

**返回值**：Umo Editor 可识别的 JSON 格式数据或 `null` 。

### startTypewriter

**说明**：以打字机效果插入内容。

**参数**：

- `content` : Umo Editor 可识别的 JSON 格式数据。
- `options` : 
  - `speed`: `Number`，打字机文字键入的间隔时间。
  - `step`: `Number`，打字机步长，每次打字的显示数量，为了保证效果，建议不要过长。
  - `onComplete`: `function`，打字机完成后的回调函数。

**返回值**：无。

### stopTypewriter

**说明**：终止打字机插入内容效果。

**参数**：无。

**返回值**：无。

### getTypewriterState

**说明**：获取打字机的运行状态。

**参数**：无。

**返回值**：

- `isRunning` :  `Boolean` 当前打字机的运行状态，`true` 表示正在运行，`false` 表示打字机已停止。
- `currentParagraph` :  `Number` 当前打字机运行到的段落位置。
- `currentTextNode` : `Number` 当前打字机运行到的段落下的文本节点位置。
- `currentChar` :  `Number` 当前打字机运行到段落下的字符位置。
